Xbasic

cron_describe Function

IN THIS PAGE

Syntax

Result as C = cron_describe(cronExpression as C)

Arguments

cronExpressionCharacter

The CRON expression to describe.

Returns

ResultCharacter

A human-readable description of the CRON expression (for example, "Every 15 minutes"). If the expression is invalid, an error description may be returned.

Description

Returns a human-readable description of a CRON expression.

Description

Use cron_describe() to convert a CRON expression into a plain-language description that is easier for end users and administrators to understand. This is especially useful in configuration UIs or reports where showing a raw CRON string would be confusing.

Example

The following example describes a CRON expression that fires every 15 minutes.

dim cronExpression as c
cronExpression = "*/15 * * * *"

? cron_describe(cronExpression)
= "Every 15 minutes"

See Also